SendBirdCall

object SendBirdCall

SendBirdCall

Since

0.6.0

Types

Options

object Options

Represents operation options.

SoundType

enum SoundType : Enum<SendBirdCall.SoundType>

SoundType

Functions

addListener

fun addListener(identifier: String, listener: SendBirdCallListener)

Adds listener.

addRecordingListener

fun addRecordingListener(identifier: String, listener: RecordingListener)

Adds a RecordingListener to the SDK which is invoked when a recording session is finished successfully.

authenticate

fun authenticate(params: AuthenticateParams, handler: AuthenticateHandler?)

Authenticates.

createDirectCallLogListQuery

fun createDirectCallLogListQuery(params: DirectCallLogListQuery.Params): DirectCallLogListQuery

Creates direct call log list query.

createRoom

fun createRoom(params: RoomParams, handler: RoomHandler?)

Creates a Room for group calls.

createRoomListQuery

fun createRoomListQuery(params: RoomListQuery.Params): RoomListQuery

Creates a query for room list with specified parameters.

deauthenticate

fun deauthenticate(handler: CompletionHandler?)

Deauthenticates.

deleteAllCustomItems

fun deleteAllCustomItems(callId: String, handler: CustomItemsHandler?)

Deletes all custom items.

deleteCustomItems

fun deleteCustomItems(callId: String, customItemKeys: Set<String>, handler: CustomItemsHandler?)

Deletes custom items.

dial

fun dial(params: DialParams, handler: DialHandler?): DirectCall?

Dials.

fetchRoomById

fun fetchRoomById(roomId: String, handler: RoomHandler?)

Fetches a room instance from Sendbird server.

getCachedRoomById

fun getCachedRoomById(roomId: String): Room?

Gets a locally-cached room instance by room ID.

getCall

fun getCall(callId: String): DirectCall?

Gets call from call ID.

getRoomInvitation

fun getRoomInvitation(roomInvitationId: String): RoomInvitation?

getSdkVersion

fun getSdkVersion(): String

Returns SDK version.

handleFirebaseMessageData

fun handleFirebaseMessageData(data: Map<String, String>): Boolean

Handles Firebase message data.

handleHmsMessageData

fun handleHmsMessageData(data: Map<String, String>): Boolean

Handles Huawei mobile services message data.

handleWebhookCommand

fun handleWebhookCommand(payload: String): Boolean

Handles a webhook command.

init

fun init(context: Context, appId: String): Boolean

Initializes SendBird Call.

registerPushToken

~~fun~~ ~~registerPushToken~~(~~pushToken~~: String, ~~unique~~: Boolean, ~~handler~~: CompletionHandler?)

fun registerPushToken(pushToken: String, pushTokenType: PushTokenType, unique: Boolean, handler: CompletionHandler?)

Registers push token for current user.

removeAllListeners

fun removeAllListeners()

Removes all listeners.

removeAllRecordingListeners

fun removeAllRecordingListeners()

Removes all RecordingListeners from the SDK.

removeListener

fun removeListener(identifier: String): SendBirdCallListener?

Removes listener.

removeRecordingListener

fun removeRecordingListener(identifier: String): RecordingListener?

Removes a RecordingListener that has the specified identifier from the SDK.

retrieveMissedDirectCalls

fun retrieveMissedDirectCalls(handler: CompletionHandler?)

Retrieves pending events from the server that were missed from the device. If there are incoming calls that were not received via push notifications, the missed calls will be given in the SendBirdCallListener.onRinging method.

setLoggerLevel

fun setLoggerLevel(level: Int)

Sets logger level.

unregisterAllPushTokens

~~fun~~ ~~unregisterAllPushTokens~~(~~handler~~: CompletionHandler?)

fun unregisterAllPushTokens(pushTokenType: PushTokenType, handler: CompletionHandler?)

Unregisters all push tokens for current user.

unregisterPushToken

~~fun~~ ~~unregisterPushToken~~(~~pushToken~~: String, ~~handler~~: CompletionHandler?)

fun unregisterPushToken(pushToken: String, pushTokenType: PushTokenType, handler: CompletionHandler?)

Unregisters push token for current user.

updateCustomItems

fun updateCustomItems(callId: String, customItems: Map<String, String>, handler: CustomItemsHandler?)

Updates custom items.

Properties

applicationId

var applicationId: String

Returns current application ID.

currentUser

val currentUser: User?

Gets the current User.

incomingCalls

val incomingCalls: List<DirectCall>

Returns all incoming calls

LOGGER_ERROR

const val LOGGER_ERROR: Int = 1

LOGGER_INFO

const val LOGGER_INFO: Int = 3

LOGGER_INFO

LOGGER_NONE

const val LOGGER_NONE: Int = 0

LOGGER_WARNING

const val LOGGER_WARNING: Int = 2

LOGGER_WARNING

ongoingCallCount

val ongoingCallCount: Int

Gets ongoing call count.

ongoingCalls

val ongoingCalls: List<DirectCall>

Returns all ongoing calls, including the active call and all calls on hold.

VERSION

const val VERSION: String

Returns current SDK version.